Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
@mdit-vue/plugin-frontmatter
Advanced tools
A markdown-it plugin to get markdown frontmatter with gray-matter.
env.frontmatter
.env.frontmatter
.env.content
.env.excerpt
.npm i @mdit-vue/plugin-frontmatter
import { frontmatterPlugin } from '@mdit-vue/plugin-frontmatter';
import type { MarkdownItEnv } from '@mdit-vue/types';
import MarkdownIt from 'markdown-it';
const md = MarkdownIt({ html: true }).use(frontmatterPlugin, {
// options
grayMatterOptions: {
excerpt: true,
excerpt_separator: '<!-- more -->',
},
});
const env: MarkdownItEnv = {};
const rendered = md.render(
`\
---
title: foobar
---
Everything above **more** comment will be extracted as excerpt.
<!-- more -->
Things below **more** comment will not be included in the excerpt.
`,
env,
);
console.log(env.frontmatter);
console.log(env.content);
console.log(env.excerpt);
Type: GrayMatterOptions
Details:
Options of gray-matter.
Type: boolean
Default: true
Render the excerpt with markdown-it or not.
This option will only take effects when grayMatterOptions.excerpt
is enabled (disabled by default) or grayMatterOptions.excerpt_separator
is set (undefined by default).
2.1.3 (2024-05-13)
Note: Version bump only for package @mdit-vue/monorepo
FAQs
A markdown-it plugin to get markdown frontmatter
The npm package @mdit-vue/plugin-frontmatter receives a total of 24,153 weekly downloads. As such, @mdit-vue/plugin-frontmatter popularity was classified as popular.
We found that @mdit-vue/plugin-frontmatter demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.